dxp-ux

listPayment

This operation retrieves the payment history by using account number.

This operation is towards

1. LCPR: Aria, Matrixx, CSG.
2. Panama: Liberate

Request URL

https://[localhost]:[port]/dxp-ux/v1/{businessId}/payment

URL PARAMS

Header

Query Param

Data Model

Response Data Model

paymentItem subResource - dataModel

extendedCharacteristics subResource - dataModel

Key considerations

• Please find the responses in following URL: DXP UX : PaymentHistory

PA Implementation

1. This implementation retrieves the payment history for FIXED, POSTPAID accounts.
2. To retrieve payment history for a specific duration, startDate and endDate queryParameters must be passed.
3. If the dates are not specified in queryParams, the API returns history of last one year by default.
4. Description field provides the billReferenceNumber.
5. statusDate field is the enteredDate in Liberate.
6. name field gives the name value which is sent during creating the payment (ThirdPartySource).
7. correlatorId field gives the correlatorId value which is sent during creating the payment (ThirdPartyPaymNo).
8. status possible values are "Returned" or "Success".
9. By default, payment history is retrieved if 'paymentItem.referredType' queryParam is not provided; if specified, it must be sent as "history"
10. For all the dateTime fields
   - Any datetime before 1908-04-22 will show offset -05:18
   - Any datetime on or after 1908-04-22 will show offset -05:00

Get Payment Plans

This API allows consumer to returns the list of payment plans on the account.

URL

https://[localhost]:[port]/dev/dxp-ux/dxp-ux/v1/{businessId}/payment

url Param

Header

Query Param

cURL request

curl --location 'https://nonprod.esb.cloud.lla.com/dev/dxp-ux/dxp-ux/v1/PR/payment?account.id=DAVE2025062416' \
--header 'X-Correlation-ID: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b' \
--header 'client_id: 784c9a6dd7ae49768816cab57fcf1fa1' \
--header 'client_secret: 187b259EB77441babbF611d2646C670d'

Response

In this section all the possible data structures received by the client at the moment of responding the method are defined.

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

[ 200 ]

OK - get request processed successfully, response body contains an entity corresponding to the requested resource.

[
    {
        "id": "23", //AriaAssignedPaymentPlanNumber
        "status": "Active", //payment_plan_status
        "paymentItem": [
            {
                "item": {
                    "id": "23", //<client_payment_plan_id>
                    "name": "Dave Test" //payment_plan_name
                }
            },
            {
                "amount": {
                    "value": 1015.1,
                    "unit": "USD"
                },
                "item": {
                    "name": "InitialBalance"
                }
            },
            {
                "amount": {
                    "value": 1015.1,
                    "unit": "USD"
                },
                "item": {
                    "name": "RemainingBalance"
                }
            },
            {
                "amount": {
                    "value": 0,
                    "unit": "USD"
                },
                "item": {
                    "name": "PaidAmount"
                }
            }
        ],
        "paymentMethod": {
            "account": [
                {
                    "id": "2109150",
                    "name": "ClientBillingGroupId"
                },
                {
                    "id": "5859395",
                    "name": "AlignedPaymentPlanClientMasterPlanInstanceId"
                }
            ]
        },
        "extendedCharacteristic": [
            {
                "name": "PaymentPlanDescription",
                "value": "Dave Test"
            },
            {
                "name": "PaymentPlanCreateDate",
                "value": "2026-08-14"
            },
            {
                "name": "FirstPaymentPlanDueDate",
                "value": "2026-09-09"
            },
            {
                "name": "LastPaymentPlanDueDate",
                "value": "2026-11-09"
            },
            {
                "name": "PaymentPlanType",
                "value": 1
            },
            {
                "name": "PaymentPlanLength",
                "value": 3
            },
            {
                "name": "TransactionOnPaymentPlanList",
                "valueType": "array",
                "value": [
                    {
                        "transactionCreateDate": "2026-06-17 01:42:04",
                        "transactionId": 585141221,
                        "invoiceNo": 1216902637
                    },
                    {
                        "transactionCreateDate": "2026-06-17 01:42:04",
                        "transactionId": 585141222,
                        "invoiceNo": 1216902637
                    },
                    {
                        "transactionCreateDate": "2026-06-17 01:42:04",
                        "transactionId": 585141223,
                        "invoiceNo": 1216902637
                    },
                    {
                        "transactionCreateDate": "2026-06-17 01:42:04",
                        "transactionId": 585141224,
                        "invoiceNo": 1216902637
                    },
                    {
                        "transactionCreateDate": "2026-07-17 01:35:24",
                        "transactionId": 590822078,
                        "invoiceNo": 1217967920
                    },
                    {
                        "transactionCreateDate": "2026-07-17 01:35:24",
                        "transactionId": 590822079,
                        "invoiceNo": 1217967920
                    },
                    {
                        "transactionCreateDate": "2026-07-17 01:35:24",
                        "transactionId": 590822080,
                        "invoiceNo": 1217967920
                    },
                    {
                        "transactionCreateDate": "2026-07-17 01:35:24",
                        "transactionId": 590822081,
                        "invoiceNo": 1217967920
                    }
                ]
            }
        ],
        "@type": "Payment"
    }
]

Definitions

Each of the request parameters is detailed.

paymentMethod account values

extendedCharacteristic values

transaction_on_payment_plan_list array values

Possible response error

In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.

[ 400 ]

Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

{
  "errors" : [{
      "code" : 400,
      "message" : "The request is invalid or not properly formed.",
      "description" : "Malformed request syntax, invalid request message framing, or deceptive request routing."
    }]
}

[ 401 ]

Unauthorized - The request has not been applied because it lacks valid authentication credentials for the target resource.

{
  "errors" : [{
      "code" : 401,
      "message" : "The user could not be authenticated for this request.",
      "description" : "The request has not been applied because it lacks valid authentication credentials for the target resource"
    }]
}

[ 404 ]

Not Found - server has not found a resource with that URI. This may be temporary and permanent condition. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.

{
  "errors" : [{
      "code" : 404,
      "message" : "The request is invalid or not properly formed.",
      "description" : "The requested operation failed because a resource associated with the request could not be found."
    }]
}

[ 405 ]

Method Not Allowed - HTTP method not allowed for this resource. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

{
    "errors": [{
            "code": 405,
             "message": "APIKIT:METHOD_NOT_ALLOWED",
             "description": "HTTP Method POST not allowed for : /{businessId}/payment"
        }]
}

[ 500 ]

Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.

{
  "errors" : [{
      "code" : 500,
      "message" : "Internal Server Error",
      "description": "The request failed due to an internal error"
    }]
}

[ 501 ]

Not implemented - indicates that the server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource.

{
  "errors" : [{
      "code" : 501,
      "message" : "Not implemented",
      "description" : "Operation GET /payment for Business Id: xxxx not implemented"
    }]
  }